fcMultiLanguage

Base Classes

Member Functions
Init
PopulateLanguageArray
PopulateClassArray
PopulateMenuArray
IsMultiLanguageSupported
IsLanguageSupported
ReturnLabel
ReturnApplicationMsg
ReturnClassMsg
ReturnStatus
ReturnMenuText
SetSupportedLanguageFileName
GetSupportedLanguageFileName
SetSupportedClassFileName
GetSupportedClassFileName
SetLanguage
GetLanguage
CurrentLanguageFlagName
ListAllSupportedLanguages
Top of Document



Boolean = Init(sApplicationPath,sClassMessageFile)


This must be run when the app is started to set up the DAT files

Parameters
sApplicationPathString.
sClassMessageFileString.

Return Value
Boolean

Top of Document


Boolean = PopulateLanguageArray()


This function will populate the saLabels array from the .DAT file.

Parameters

Return Value
Boolean

Top of Document


Boolean = PopulateClassArray()


This function will populate the class messages array from the .DAT file.

Parameters

Return Value
Boolean

Top of Document


Boolean = PopulateMenuArray()


This function will populate the menu array from the .DAT file.

Parameters

Return Value
Boolean

Top of Document


Boolean = IsMultiLanguageSupported()


THis function will tell you if a selected language is supported in the .DAT file

Parameters

Return Value
Boolean

Top of Document


Boolean = IsLanguageSupported(sLanguageQuery)


This function will return if a language is supported in the current .DAT file.

Parameters
sLanguageQueryString.

Return Value
Boolean

Top of Document


Boolean = ReturnLabel(nArrayElement,sTag)


This function will query the saLabel array and return the text value in it to the calling window.

Parameters
nArrayElementNumber.
sTagReceive String.

Return Value
Boolean

Top of Document


Boolean = ReturnApplicationMsg(nArrayElement,sTag)


This function will query the saMessage array and return the text value in it to the calling window.

Parameters
nArrayElementNumber.
sTagReceive String.

Return Value
Boolean

Top of Document


Boolean = ReturnClassMsg(nArrayElement,sTag)


This function will query the saMessage array and return the text value in it to the calling window.

Parameters
nArrayElementNumber.
sTagReceive String.

Return Value
Boolean

Top of Document


Boolean = ReturnStatus(nArrayElement,sTag)


This function will query the saStatus array and return the text value in it to the calling window.

Parameters
nArrayElementNumber.
sTagReceive String.

Return Value
Boolean

Top of Document


String = ReturnMenuText(nArrayElement)


This function will return the requested menu text.

Parameters
nArrayElementNumber.

Return Value
String

Top of Document


Boolean = SetSupportedLanguageFileName(sAppPath)


This function is to be used to tell the FC the language file to use. If the file does not exist the function will return FALSE. If the file exists the function will return TRUE.

Parameters
sAppPathString.

Return Value
Boolean

Top of Document


Boolean = GetSupportedLanguageFileName(sFilePath)


This function is to be used to tell the FC the language file to use. If the file does not exist the function will return FALSE. If the file exists the function will return TRUE.

Parameters
sFilePathReceive String.

Return Value
Boolean

Top of Document


Boolean = SetSupportedClassFileName(sAppPath)


This function is to be used to tell the FC the class file to use. If the file does not exist the function will return FALSE. If the file exists the function will return TRUE.

Parameters
sAppPathString.

Return Value
Boolean

Top of Document


Boolean = GetSupportedClassFileName(sFilePath)


This function is to be used to tell the FC the class file to use. If the file does not exist the function will return FALSE. If the file exists the function will return TRUE.

Parameters
sFilePathReceive String.

Return Value
Boolean

Top of Document


Boolean = SetLanguage(sLanguageToSet)


This function will set the current language selection.

Parameters
sLanguageToSetString.

Return Value
Boolean

Top of Document


Boolean = GetLanguage(sLanguage)


This function will return the current language selection.

Parameters
sLanguageReceive String.

Return Value
Boolean

Top of Document


Boolean = CurrentLanguageFlagName(sFlagName)


This function will return the name of the flag to be displayed in the pic.

Parameters
sFlagNameString.

Return Value
Boolean

Top of Document


Boolean = ListAllSupportedLanguages(saDescription[*],saConstants[*],saFlagPath[*],nLanguageArrayStart,nLanguageArrayEnd)


Parameters
saDescription[*]Receive String.
saConstants[*]Receive String.
saFlagPath[*]Receive String.
nLanguageArrayStartReceive Number.
nLanguageArrayEndReceive Number.

Return Value
Boolean

Top of Document